/*
 * sysmo 服务器监控值类
 * Copyright (C) 2009  YuLicheng
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.sysmo.server.node.item.graphgroup.value;

import java.util.List;
import org.sysmo.db.DatabaseInterface;
import org.sysmo.server.node.item.Result;
import org.sysmo.server.util.TimeInterval;

/**
 * 
 * 监控值对象。监控值是监控的最小记录单位。
 * <br />
 * 
 * 使用客户端发送的监控数据经过传递最终将由监控值对象将对应的值存入数据库。
 * <br />
 *
 * 此模块不需要与客户端之间直接进行任何通讯。
 *
 * @author YuLicheng
 */
public class Value {

    private DatabaseInterface dbInterface;
    private int id;

    /**
     * 监控值的统计类型枚举。统计类型用于选择数据项的表现方式。可以对已有的数据
     * 进行积分或求导运算后再绘制图表，以便查看监控值记录的累计情况或速度等。
     */
    public enum StatisticType {
        /**
         * 标量。即绘制图表时直接用原始数据。
         */
        SCALAR,
        /**
         * 累加量。即绘制图表时使用对现有数据进行积分运算后的结果。
         */
        ACCUMULATED,
        /**
         * 导数量。即绘制图表时使用对现有数据进行求导运算后的结果。
         */
        DERIVATIVE;
    };

    /**
     * 实例化数据库中已存在的监控值。
     *
     * @param dbInterface 数据库访问接口。
     * @param id 监控值ID。
     * @throws ValueNotExistsException 若监控值ID不存在则抛出此异常。
     */
    public Value(DatabaseInterface dbInterface, int id)
            throws ValueNotExistsException {
        this.dbInterface = dbInterface;
        this.id = id;
    }

    /**
     * 创建一个新监控值。
     *
     * @param dbInterface 数据库接口。
     * @param name 新监控值名称。
     * @param graphID 所属图表ID。
     * @throws ValueExistsException 若存在同名监控值则抛出此异常。
     */
    public Value(DatabaseInterface dbInterface, String name, int graphID)
            throws ValueExistsException {
        this.dbInterface = dbInterface;
    }

    /**
     * 设置监控值名称。
     *
     * @param name 监控值新名称。
     * @throws ValueExistsException 若存在同名监控值则抛出此异常。
     */
    public void setName(String name) throws ValueExistsException {

    }

    /**
     * 获取此监控值名称。
     *
     * @return 监控值名称。
     */
    public String getName() {
        return null;
    }

    /**
     * 获取此监控值ID。
     *
     * @return 监控值ID。
     */
    public int getID() {
        return id;
    }

    /**
     * 设置此监控值的记录取值范围。此范围会用于图表绘制。
     *
     * @param low 记录可能的最小值。
     * @param high 记录可能的最大值。
     * @throws IllegalArgumentException 若指定的最大值小于最小值则抛出此异常。
     */
    public void setRange(int low, int high) throws IllegalArgumentException {
        
    }

    /**
     * 返回此监控值记录取值下限。
     *
     * @return 监控值记录取值下限。
     */
    public int getRangeLow() {
        return 0;
    }

    /**
     * 返回此监控值记录取值上限。
     *
     * @return 监控值记录取值上限。
     */
    public int getRangeHigh() {
        return 0;
    }

    /**
     * 返回此监控项的统计类型。
     *
     * @return 统计类型对象。
     * @see StatisticType
     */
    public StatisticType getStatisticType() {
        return null;
    }

    /**
     * 设置此监控项的统计类型。
     *
     * @param statisticType
     * @see StatisticType
     */
    public void setStatisticType(StatisticType statisticType) {
        
    }

    /**
     * 保存客户端发送的监控数据。此方法会将相应的数据存入数据库。
     * <br />
     *
     * 此方法会忽略非本图表的记录，并调用相应的监控值的saveData方法来存储。
     *
     * @param values 监控结果集合。
     */
    public void saveData(List<Result> values) {

    }

    /**
     * 按时间获取记录。
     *
     * @param dataRange 数据时间段。
     * @return 指定时间段记录列表。
     */
    public List<Result> getResults(TimeInterval dataRange) {
        return null;
    }
}
